<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.2">
<meta name="author" content="朋也">
<title>朋也社区文档</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400">
<style>
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
/* Remove the comments around the @import statement below when using this as a custom stylesheet */
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";*/
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
audio,canvas,video{display:inline-block}
audio:not([controls]){display:none;height:0}
[hidden],template{display:none}
script{display:none!important}
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
body{margin:0}
a{background:transparent}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
abbr[title]{border-bottom:1px dotted}
b,strong{font-weight:bold}
dfn{font-style:italic}
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
html,body{font-size:100%}
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
#map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
.antialiased,body{-webkit-font-smoothing:antialiased}
img{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:none}
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.no-bullet{list-style:none}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
abbr{text-transform:none}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
blockquote cite:before{content:"\2014 \0020"}
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
table thead,table tfoot{background:#f7f8f7;font-weight:bold}
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
.clearfix:after,.float-group:after{clear:both}
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
.keyseq{color:rgba(51,51,51,.8)}
kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menu{color:rgba(0,0,0,.8)}
b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
b.button:before{content:"[";padding:0 3px 0 2px}
b.button:after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
#header:after,#content:after,#footnotes:after,#footer:after{clear:both}
#content{margin-top:1.25em}
#content:before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span:before{content:"\00a0\2013\00a0"}
#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark:before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber:after{content:"\00a0"}
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
#toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media only screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
#toc.toc2 #toctitle{margin-top:0;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
.sect1{padding-bottom:.625em}
@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed}
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.listingblock>.content{position:relative}
.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
.listingblock:hover code[data-lang]:before{display:block}
.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0}
table.pyhltable td.code{padding-left:.75em;padding-right:0}
pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
pre.pygments .lineno{display:inline-block;margin-right:.25em}
table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
.quoteblock blockquote{margin:0;padding:0;border:0}
.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
.quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
.quoteblock .quoteblock blockquote:before{display:none}
.verseblock{margin:0 1em 1.25em 1em}
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)}
.quoteblock.abstract{margin:0 0 1.25em 0;display:block}
.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
table.tableblock{max-width:100%;border-collapse:separate}
table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
table.spread{width:100%}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0}
table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0}
table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0}
table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0}
table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0}
table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0}
table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0}
table.frame-all{border-width:1px}
table.frame-sides{border-width:0 1px}
table.frame-topbot{border-width:1px 0}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
td>div.verse{white-space:pre}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none}
ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em}
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em}
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px}
ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
ul.inline>li>*{display:block}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1{padding-right:.75em;font-weight:bold}
td.hdlist1,td.hdlist2{vertical-align:top}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1}
.colist>table tr>td:last-of-type{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none}
span.footnote,span.footnoteref{vertical-align:super;font-size:.875em}
span.footnote a,span.footnoteref a{text-decoration:none}
span.footnote a:active,span.footnoteref a:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
#footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
.gist .file-data>table td.line-data{width:99%}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background-color:#00fafa}
.black{color:#000}
.black-background{background-color:#000}
.blue{color:#0000bf}
.blue-background{background-color:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background-color:#fa00fa}
.gray{color:#606060}
.gray-background{background-color:#7d7d7d}
.green{color:#006000}
.green-background{background-color:#007d00}
.lime{color:#00bf00}
.lime-background{background-color:#00fa00}
.maroon{color:#600000}
.maroon-background{background-color:#7d0000}
.navy{color:#000060}
.navy-background{background-color:#00007d}
.olive{color:#606000}
.olive-background{background-color:#7d7d00}
.purple{color:#600060}
.purple-background{background-color:#7d007d}
.red{color:#bf0000}
.red-background{background-color:#fa0000}
.silver{color:#909090}
.silver-background{background-color:#bcbcbc}
.teal{color:#006060}
.teal-background{background-color:#007d7d}
.white{color:#bfbfbf}
.white-background{background-color:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background-color:#fafa00}
span.icon>.fa{cursor:default}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]:after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
h1,h2{letter-spacing:-.01em}
dt,th.tableblock,td.content{text-rendering:optimizeLegibility}
p,td.content{letter-spacing:-.01em}
p strong,td.content strong{letter-spacing:-.005em}
p,blockquote,dt,td.content{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@media print{@page{margin:1.25cm .75cm}
*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]:after{content:" (" attr(title) ")"}
pre,blockquote,tr,img{page-break-inside:avoid}
thead{display:table-header-group}
img{max-width:100%!important}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
.sect1{padding-bottom:0!important}
.sect1+.sect1{border:0!important}
#header>h1:first-child{margin-top:1.25rem}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span:before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]:before{display:block}
#footer{background:none!important;padding:0 .9375em}
#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
</style>
<link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/font-awesome/4.2.0/css/font-awesome.min.css">
<style>
/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
/*pre.CodeRay {background-color:#f7f7f8;}*/
.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
.CodeRay .line-numbers strong{font-weight: normal}
table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
table.CodeRay td{vertical-align: top}
table.CodeRay td.line-numbers{text-align:right}
table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
table.CodeRay td.code{padding:0 0 0 .5em}
table.CodeRay td.code>pre{padding:0}
.CodeRay .debug{color:#fff !important;background:#000080 !important}
.CodeRay .annotation{color:#007}
.CodeRay .attribute-name{color:#000080}
.CodeRay .attribute-value{color:#700}
.CodeRay .binary{color:#509}
.CodeRay .comment{color:#998;font-style:italic}
.CodeRay .char{color:#04d}
.CodeRay .char .content{color:#04d}
.CodeRay .char .delimiter{color:#039}
.CodeRay .class{color:#458;font-weight:bold}
.CodeRay .complex{color:#a08}
.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
.CodeRay .color{color:#099}
.CodeRay .class-variable{color:#369}
.CodeRay .decorator{color:#b0b}
.CodeRay .definition{color:#099}
.CodeRay .delimiter{color:#000}
.CodeRay .doc{color:#970}
.CodeRay .doctype{color:#34b}
.CodeRay .doc-string{color:#d42}
.CodeRay .escape{color:#666}
.CodeRay .entity{color:#800}
.CodeRay .error{color:#808}
.CodeRay .exception{color:inherit}
.CodeRay .filename{color:#099}
.CodeRay .function{color:#900;font-weight:bold}
.CodeRay .global-variable{color:#008080}
.CodeRay .hex{color:#058}
.CodeRay .integer,.CodeRay .float{color:#099}
.CodeRay .include{color:#555}
.CodeRay .inline{color:#00}
.CodeRay .inline .inline{background:#ccc}
.CodeRay .inline .inline .inline{background:#bbb}
.CodeRay .inline .inline-delimiter{color:#d14}
.CodeRay .inline-delimiter{color:#d14}
.CodeRay .important{color:#555;font-weight:bold}
.CodeRay .interpreted{color:#b2b}
.CodeRay .instance-variable{color:#008080}
.CodeRay .label{color:#970}
.CodeRay .local-variable{color:#963}
.CodeRay .octal{color:#40e}
.CodeRay .predefined{color:#369}
.CodeRay .preprocessor{color:#579}
.CodeRay .pseudo-class{color:#555}
.CodeRay .directive{font-weight:bold}
.CodeRay .type{font-weight:bold}
.CodeRay .predefined-type{color:inherit}
.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
.CodeRay .key{color:#808}
.CodeRay .key .delimiter{color:#606}
.CodeRay .key .char{color:#80f}
.CodeRay .value{color:#088}
.CodeRay .regexp .delimiter{color:#808}
.CodeRay .regexp .content{color:#808}
.CodeRay .regexp .modifier{color:#808}
.CodeRay .regexp .char{color:#d14}
.CodeRay .regexp .function{color:#404;font-weight:bold}
.CodeRay .string{color:#d20}
.CodeRay .string .string .string{background:#ffd0d0}
.CodeRay .string .content{color:#d14}
.CodeRay .string .char{color:#d14}
.CodeRay .string .delimiter{color:#d14}
.CodeRay .shell{color:#d14}
.CodeRay .shell .delimiter{color:#d14}
.CodeRay .symbol{color:#990073}
.CodeRay .symbol .content{color:#a60}
.CodeRay .symbol .delimiter{color:#630}
.CodeRay .tag{color:#008080}
.CodeRay .tag-special{color:#d70}
.CodeRay .variable{color:#036}
.CodeRay .insert{background:#afa}
.CodeRay .delete{background:#faa}
.CodeRay .change{color:#aaf;background:#007}
.CodeRay .head{color:#f8f;background:#505}
.CodeRay .insert .insert{color:#080}
.CodeRay .delete .delete{color:#800}
.CodeRay .change .change{color:#66f}
.CodeRay .head .head{color:#f4f}
</style>
</head>
<body class="article toc2 toc-left">
<div id="header">
<h1>朋也社区文档</h1>
<div class="details">
<span id="author" class="author">朋也</span><br>
<span id="email" class="email">&lt;<a href="mailto:py2qiuse@gmail.com">py2qiuse@gmail.com</a>&gt;</span><br>
<span id="revdate">2020-04-21</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#简介">简介</a>
<ul class="sectlevel2">
<li><a href="#为什么使用它">为什么使用它？</a></li>
<li><a href="#使用朋也社区收费吗">使用朋也社区收费吗？</a></li>
<li><a href="#使用过程中碰到问题怎么办">使用过程中碰到问题怎么办？</a></li>
</ul>
</li>
<li><a href="#快速开始">快速开始</a>
<ul class="sectlevel2">
<li><a href="#准备环境-必须">准备环境[必须]</a></li>
<li><a href="#准备环境-非必须">准备环境[非必须]</a></li>
<li><a href="#开发人员搭建">开发人员搭建</a></li>
<li><a href="#非开发人员搭建">非开发人员搭建</a></li>
<li><a href="#docker运行">docker运行</a></li>
</ul>
</li>
<li><a href="#朋也社区案例">朋也社区案例</a></li>
<li><a href="#系统配置">系统配置</a>
<ul class="sectlevel2">
<li><a href="#基本配置">基本配置</a></li>
<li><a href="#邮箱配置">邮箱配置</a></li>
<li><a href="#elasticsearch配置">ElasticSearch配置</a></li>
<li><a href="#redis配置">Redis配置</a></li>
<li><a href="#上传配置">上传配置</a></li>
<li><a href="#非nginx静态映射配置">非nginx静态映射配置</a></li>
<li><a href="#nginx静态文件映射配置方法">nginx静态文件映射配置方法</a></li>
<li><a href="#静态文件访问地址">静态文件访问地址</a></li>
<li><a href="#github登录配置方法">Github登录配置方法</a></li>
<li><a href="#微信登录配置方法">微信登录配置方法</a></li>
<li><a href="#短信验证码登录-注册">短信验证码登录/注册</a></li>
<li><a href="#开启websocket">开启WebSocket</a></li>
<li><a href="#内置主题">内置主题</a></li>
<li><a href="#更换主题">更换主题</a></li>
</ul>
</li>
<li><a href="#公网部署">公网部署</a>
<ul class="sectlevel2">
<li><a href="#部署步骤">部署步骤</a></li>
<li><a href="#nginx配置">nginx配置</a></li>
<li><a href="#frp映射配置">frp映射配置</a></li>
<li><a href="#配置https">配置https</a></li>
</ul>
</li>
<li><a href="#主题开发">主题开发</a>
<ul class="sectlevel2">
<li><a href="#主题目录">主题目录</a></li>
<li><a href="#全局对象">全局对象</a>
<ul class="sectlevel3">
<li><a href="#model对象内的方法">model对象内的方法</a></li>
<li><a href="#site对象中的属性">site对象中的属性</a></li>
<li><a href="#i18n对象中的属性">i18n对象中的属性</a></li>
</ul>
</li>
<li><a href="#freemarker自定义标签">Freemarker自定义标签</a>
<ul class="sectlevel3">
<li><a href="#标签-tag_topics-对象中的map包含的字段">标签 tag_topics 对象中的Map包含的字段</a></li>
<li><a href="#标签-tag_notifications-对象中的map包含的字段">标签 tag_notifications 对象中的Map包含的字段</a></li>
<li><a href="#标签-tag_search-对象中的map包含的字段">标签 tag_search 对象中的Map包含的字段</a></li>
<li><a href="#标签-tag_user_topics-对象中的map包含的字段">标签 tag_user_topics 对象中的Map包含的字段</a></li>
<li><a href="#标签-tag_user_comments-对象中的map包含的字段">标签 tag_user_comments 对象中的Map包含的字段</a></li>
<li><a href="#标签-tag_user_collects-对象中的map包含的字段">标签 tag_user_collects 对象中的Map包含的字段</a></li>
</ul>
</li>
<li><a href="#自定义标签使用">自定义标签使用</a></li>
<li><a href="#路由渲染可获取对象">路由渲染可获取对象</a></li>
<li><a href="#对象包含的字段">对象包含的字段</a>
<ul class="sectlevel3">
<li><a href="#分页对象-page">分页对象 Page</a></li>
<li><a href="#用户对象-user">用户对象 User</a></li>
<li><a href="#话题对象-topic">话题对象 Topic</a></li>
<li><a href="#评论对象-comment">评论对象 Comment</a></li>
<li><a href="#评论-盖楼-对象-commentsbytopic">评论(盖楼)对象 CommentsByTopic</a></li>
<li><a href="#通知对象-notification">通知对象 Notification</a></li>
<li><a href="#授权登录对象-oauthuser">授权登录对象 OAuthUser</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#接口文档">接口文档</a>
<ul class="sectlevel2">
<li><a href="#获取token">获取token</a></li>
<li><a href="#请求接口示例">请求接口示例</a></li>
<li><a href="#接口返回对象">接口返回对象</a></li>
<li><a href="#接口返回分页对象">接口返回分页对象</a></li>
<li><a href="#图片验证码">图片验证码</a></li>
<li><a href="#首页-首页列表">首页 - 首页列表</a></li>
<li><a href="#首页-登录">首页 - 登录</a></li>
<li><a href="#首页-注册">首页 - 注册</a></li>
<li><a href="#首页-发送手机验证码">首页 - 发送手机验证码</a></li>
<li><a href="#首页-手机号-验证码登录-注册">首页 - 手机号+验证码登录/注册</a></li>
<li><a href="#首页-标签">首页 - 标签</a></li>
<li><a href="#首页-上传文件-图片-视频">首页 - 上传文件（图片，视频）</a></li>
<li><a href="#话题-话题详情">话题 - 话题详情</a></li>
<li><a href="#话题-发布话题">话题 - 发布话题</a></li>
<li><a href="#话题-编辑话题">话题 - 编辑话题</a></li>
<li><a href="#话题-删除话题">话题 - 删除话题</a></li>
<li><a href="#话题-点赞话题">话题 - 点赞话题</a></li>
<li><a href="#评论-发布评论">评论 - 发布评论</a></li>
<li><a href="#评论-更新评论">评论 - 更新评论</a></li>
<li><a href="#评论-删除评论">评论 - 删除评论</a></li>
<li><a href="#评论-点赞评论">评论 - 点赞评论</a></li>
<li><a href="#收藏-收藏话题">收藏 - 收藏话题</a></li>
<li><a href="#收藏-取消收藏">收藏 - 取消收藏</a></li>
<li><a href="#通知-未读消息个数">通知 - 未读消息个数</a></li>
<li><a href="#通知-标记消息已读">通知 - 标记消息已读</a></li>
<li><a href="#通知-消息列表">通知 - 消息列表</a></li>
<li><a href="#用户-用户信息">用户 - 用户信息</a></li>
<li><a href="#用户-用户话题列表">用户 - 用户话题列表</a></li>
<li><a href="#用户-用户评论列表">用户 - 用户评论列表</a></li>
<li><a href="#用户-用户收藏列表">用户 - 用户收藏列表</a></li>
<li><a href="#设置-更新个人信息">设置 - 更新个人信息</a></li>
<li><a href="#设置-发送激活邮件">设置 - 发送激活邮件</a></li>
<li><a href="#设置-发送邮箱验证码">设置 - 发送邮箱验证码</a></li>
<li><a href="#设置-更新用户邮箱">设置 - 更新用户邮箱</a></li>
<li><a href="#设置-修改密码">设置 - 修改密码</a></li>
<li><a href="#设置-刷新token">设置 - 刷新token</a></li>
</ul>
</li>
<li><a href="#q-a">Q&amp;A</a>
<ul class="sectlevel2">
<li><a href="#数据库在哪">数据库在哪？</a></li>
<li><a href="#发帖技巧">发帖技巧</a></li>
<li><a href="#上传的图片为啥不显示">上传的图片为啥不显示</a></li>
<li><a href="#上传的视频格式有哪些">上传的视频格式有哪些</a></li>
<li><a href="#上传视频报413错误">上传视频报413错误</a></li>
<li><a href="#后台用户名密码是多少">后台用户名密码是多少？</a></li>
<li><a href="#启动项目时报错">启动项目时报错</a></li>
<li><a href="#redis配置失败">redis配置失败</a></li>
<li><a href="#发帖或者评论有emoji时提交失败">发帖或者评论有emoji时提交失败</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="简介"><a class="anchor" href="#简介"></a>简介</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="为什么使用它"><a class="anchor" href="#为什么使用它"></a>为什么使用它？</h3>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
为高度定制化而生的论坛, 内置了异常强大的功能, 使用主流Java web开发框架(SpringBoot)开发, 更方便你进行二次开发, 还在犹豫什么, 用就是了
</td>
</tr>
</table>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>异常详细的文档</p>
</li>
<li>
<p>丰富多彩的主题</p>
</li>
<li>
<p>随心所欲的开启/关闭各种集成的服务</p>
</li>
<li>
<p>傻瓜式部署，让不懂开发的你也能搭建自己的论坛</p>
</li>
<li>
<p>强大的API接口，为学习编程的你提供服务端环境</p>
</li>
<li>
<p>更多功能，期待你去发现</p>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="使用朋也社区收费吗"><a class="anchor" href="#使用朋也社区收费吗"></a>使用朋也社区收费吗？</h3>
<div class="paragraph">
<p>开源协议是 <code>GNU AGPLv3</code></p>
</div>
<div class="paragraph">
<p><strong>完全免费</strong> 源代码毫不保留的全部开源，怕留后门的，可以自行查看，不过要遵守开源协议哦</p>
</div>
<div class="paragraph">
<p>觉得好用(对你有帮助的话) 也可以请朋也喝杯茶</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p><strong>如果你跟朋也一样, 囊中羞涩, 也可以考虑帮忙点点朋也博客上的广告, 先行谢过!</strong> 博客地址: <a href="https://tomoya92.github.io" class="bare">https://tomoya92.github.io</a></p>
</div>
<div class="paragraph">
<p><strong>如果你想二次开发，咱们关上门好商量</strong> Email: <a href="mailto:py2qiuse@gmail.com">py2qiuse@gmail.com</a></p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><span class="image"><img src="https://cloud.githubusercontent.com/assets/6915570/18000010/9283d530-6bae-11e6-8c34-cd27060b9074.png" alt="9283d530-6bae-11e6-8c34-cd27060b9074"></span>
<span class="image"><img src="https://cloud.githubusercontent.com/assets/6915570/17999995/7c2a4db4-6bae-11e6-891c-4b6bc4f00f4b.png" alt="7c2a4db4-6bae-11e6-891c-4b6bc4f00f4b"></span></p>
</div>
</div>
<div class="sect2">
<h3 id="使用过程中碰到问题怎么办"><a class="anchor" href="#使用过程中碰到问题怎么办"></a>使用过程中碰到问题怎么办？</h3>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>往下翻, 仔细查看Q&amp;A</p>
</li>
<li>
<p>去 <a href="https://17dev.club">开发俱乐部</a> 上提问，这个网站是朋也自行搭建的，目的是提供一个无嘲讽的学习编程的环境 <strong>推荐&radic;</strong></p>
</li>
<li>
<p>去Github Issue上提问，我每天都会打开Github，看到有消息立即就会回复</p>
</li>
<li>
<p>QQ群 1048094312</p>
</li>
</ol>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="快速开始"><a class="anchor" href="#快速开始"></a>快速开始</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="准备环境-必须"><a class="anchor" href="#准备环境-必须"></a>准备环境[必须]</h3>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Java环境，项目是用java开发的，java运行环境是必须的，版本：jdk8</p>
</li>
<li>
<p>MySQL数据库服务，项目采用MySQL存储数据，所以MySQL是必须的，版本5.7.x</p>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="准备环境-非必须"><a class="anchor" href="#准备环境-非必须"></a>准备环境[非必须]</h3>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>redis</p>
</li>
<li>
<p>elasticsearch</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>这两个服务在下面配置中有介绍</p>
</div>
<div class="paragraph">
<p>就这两样，就可以搭建一个自己的论坛了，当然这只限于局域网内使用，如果想搭建上线，请查看下面的配置方法</p>
</div>
</div>
<div class="sect2">
<h3 id="开发人员搭建"><a class="anchor" href="#开发人员搭建"></a>开发人员搭建</h3>
<div class="ulist">
<ul>
<li>
<p>git clone <a href="https://github.com/tomoya92/pybbs" class="bare">https://github.com/tomoya92/pybbs</a></p>
</li>
<li>
<p>使用idea打开，项目用的是idea开发的，如果你对eclipse熟悉，也是可以的</p>
</li>
<li>
<p>idea打开它会自动构建项目，构建工具是maven</p>
</li>
<li>
<p>修改配置文件 <code>src/main/resources/application-dev.yml</code> 里的数据库相关配置</p>
</li>
<li>
<p>找到`co.yiiu.pybbs.PybbsApplication`类，直接运行main方法即可启动</p>
</li>
<li>
<p>浏览器运行 <code>http://localhost:8080</code> , 后台地址 <code>http://localhost:8080/adminlogin</code> 后台用户名 admin 密码 123123</p>
</li>
</ul>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
如果要自己打包，可使用命令：<code>mvn clean compile package</code> 进行打包，不要尝试使用其它方式打包
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="非开发人员搭建"><a class="anchor" href="#非开发人员搭建"></a>非开发人员搭建</h3>
<div class="ulist">
<ul>
<li>
<p>首先保证你服务器上配置好了 java 环境，版本 jdk1.8 和 MySQL服务器，版本 5.7.x 其它可选环境配置参见 [网站准备工作](zh-cn/ready)</p>
</li>
<li>
<p>然后下载最新的一键启动压缩包，下载地址：https://github.com/tomoya92/pybbs/releases</p>
</li>
<li>
<p>解压, 修改解压出来的文件夹里的 <code>application-prod.yml</code> 文件，只需要修改一个地方，就是数据库的连接信息，[配置方法](zh-cn/base)</p>
</li>
<li>
<p>运行压缩包里的脚本 <code>sh start.sh</code></p>
</li>
<li>
<p>关闭服务运行 <code>sh shutdown.sh</code></p>
</li>
<li>
<p>查看启动日志 <code>tail -200f log.file</code></p>
</li>
<li>
<p>查看服务是否启动 <code>ps -ef|grep pybbs</code> 如果有pybbs的进程，就说明服务启动了</p>
</li>
<li>
<p>浏览器运行 <code>http://localhost:8080</code> , 后台地址 <code>http://localhost:8080/adminlogin</code> 后台用户名 admin 密码 123123</p>
</li>
<li>
<p>网站的其它配置，参见文档</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="docker运行"><a class="anchor" href="#docker运行"></a>docker运行</h3>
<div class="ulist">
<ul>
<li>
<p>保证服务器有docker和docker-compose环境</p>
</li>
<li>
<p><code>git clone https://github.com/tomoya92/pybbs</code> 或 下载最新版</p>
</li>
<li>
<p>cd pybbs进入项目</p>
</li>
<li>
<p>运行 <code>docker-compose up -d</code> 命令启动容器，-d是后台运行的意思</p>
</li>
<li>
<p>浏览器运行 <code>http://localhost:8080</code> , 后台地址 <code>http://localhost:8080/adminlogin</code> 后台用户名 admin 密码 123123</p>
</li>
<li>
<p>关闭容器 <code>docker-compose down</code></p>
</li>
<li>
<p>查看日志 <code>docker-compose logs -f server</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p><strong>第一次运行会比较慢,视服务器性能和网速决定</strong></p>
</div>
<div class="paragraph">
<p><strong>项目根目录下会生成 <code>mysql</code> 文件夹为数据库文件,注意谨慎操作，另外论坛启动后，用户上传的图片和系统生成的默认头像会自动同步到根目录下的 <code>static</code> 文件夹下</strong></p>
</div>
<div class="paragraph">
<p><strong>这个Dockerfile是 <a href="https://github.com/zzzzbw">@zzzzbw</a> 大佬帮忙开发的 万分感谢！！</strong></p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<strong>自己实在部署不好，朋也也可以代劳，不过是有偿的哦</strong>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="朋也社区案例"><a class="anchor" href="#朋也社区案例"></a>朋也社区案例</h2>
<div class="sectionbody">
<div class="paragraph">
<p>欢迎大家提交使用pybbs部署的网站地址, 可以通过邮件我告知 <a href="mailto:py2qiuse@gmail.com">py2qiuse@gmail.com</a></p>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">版本</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">域名</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect1">
<h2 id="系统配置"><a class="anchor" href="#系统配置"></a>系统配置</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="基本配置"><a class="anchor" href="#基本配置"></a>基本配置</h3>
<div class="paragraph">
<p>这版的配置相对其它版本的配置要简单的多，唯一要配置的就是数据库相关的配置了(如果你的数据库用户名是root 密码是空的，数据库又是跟程序在一个机器上，那就不需要配置)</p>
</div>
<div class="paragraph">
<p>配置数据库连接找到配置文件修改如下配置</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>src/main/resources/application-dev.yml</code> 开发启动时的配置文件</p>
</li>
<li>
<p><code>src/main/resources/application-prod.yml</code> 部署时的配置文件</p>
</li>
<li>
<p><code>src/main/resources/application-docker.yml</code> 通过docker启动时的配置文件</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="yml"><span class="key">datasource_driver</span>: <span class="string"><span class="content">com.mysql.cj.jdbc.Driver</span></span>
<span class="key">datasource_url</span>: <span class="string"><span class="content">jdbc:mysql://localhost:3306/pybbs?useSSL=false&amp;characterEncoding=utf8</span></span>
<span class="key">datasource_username</span>: <span class="string"><span class="content">root</span></span>
<span class="key">datasource_password</span>:</code></pre>
</div>
</div>
<div class="paragraph">
<p>关于其它的配置，启动程序 &#8594; 访问后台 &#8594; 系统设置  如图</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/2019-01-03T07-26-04.441Z.png" alt="2019-01-03T07-26-04.441Z"></span></p>
</div>
<div class="paragraph">
<p>有几个地方是必须要修改的，如下图中红框中的配置</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190103-155656.png" alt="QQ20190103-155656"></span></p>
</div>
<div class="paragraph">
<p><strong>注意:</strong></p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>网站的访问域名如果为 <code>http://example.com</code> 那么 <code>网站部署后访问的域名，注意这个后面没有 "/"</code> 这个说明下的内容就应该替换成 <code>http://example.com</code></p>
</li>
<li>
<p>第一步配置好域名后，cookie 的域名设置也要做相应的修改，否则用户登录的记录没法保存下来，在 <code>存cookie时用到的域名，要与网站部署后访问的域名一致</code> 这个说明下将 <code>localhost</code> 替换成 <code>example.com</code> 即可</p>
</li>
<li>
<p>除了上面两条必须要修改外，网站的上传路径也要提前做好配置，具体参见 上传配置</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>其它的配置根据自己环境做相应的修改即可</p>
</div>
</div>
<div class="sect2">
<h3 id="邮箱配置"><a class="anchor" href="#邮箱配置"></a>邮箱配置</h3>
<div class="paragraph">
<p>用户注册没有做邮箱验证，但用户可以在自己的设置页面添加邮箱</p>
</div>
<div class="paragraph">
<p>添加邮箱的时候，要发邮箱验证码，这时候就要在后台配置发邮件的邮箱配置了</p>
</div>
<div class="paragraph">
<p>我使用qq邮箱测试是没有问题的，具体配置方法，在后台已经内置了一些信息，稍做修改即可使用</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
我只测试了QQ邮箱, 配置邮箱请首先以QQ邮箱配置, 如果没有问题, 可以尝试换成其它平台的邮箱
</td>
</tr>
</table>
</div>
<hr>
<div class="paragraph">
<p>发现还有好多人配不好qq的邮件，这里介绍一下qq邮件的密码获取方式</p>
</div>
<div class="paragraph">
<p>登录qq邮件 mail.qq.com ，然后打开设置 &#8594; 帐户 往下翻，找到 <code>POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服务</code></p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/TIM20190417185246.png" alt="TIM20190417185246"></span></p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/TIM20190417185315.png" alt="TIM20190417185315"></span></p>
</div>
<div class="paragraph">
<p>点击 <code>生成授权码</code> 然后用手机扫描授权（直接使用手机qq的扫描功能就可以了），成功后，会有一个授权码，这个就是邮件的密码了</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/TIM20190417185600.png" alt="TIM20190417185600"></span></p>
</div>
<hr>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190103-154507.png" alt="QQ20190103-154507"></span></p>
</div>
</div>
<div class="sect2">
<h3 id="elasticsearch配置"><a class="anchor" href="#elasticsearch配置"></a>ElasticSearch配置</h3>
<div class="paragraph">
<p>程序内置了elasticsearch功能，不过要增加相应的配置才能用</p>
</div>
<div class="paragraph">
<p>此功能默认是关闭的，具体的配置方法如下</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>下载elasticsearch,版本建议 6.5.3 我用的就是这个版本做的开发的</p>
</li>
<li>
<p>安装ik分词插件，如果你懂命令行操作,可以执行这条命令 <code>cd elasticsearch-6.5.3/bin &amp;&amp; ./elasticsearch-plugin install https://github.com/medcl/elasticsearch-analysis-ik/releases/download/v6.5.3/elasticsearch-analysis-ik-6.5.3.zip</code></p>
</li>
<li>
<p>启动程序，进入后台，打开系统设置</p>
</li>
<li>
<p>具体操作如下图所示</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>打开搜索功能的开关</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190103-135005.png" alt="QQ20190103-135005"></span></p>
</div>
<div class="paragraph">
<p>配置ES的连接(连接信息根据自己环境做相应的修改，不一定是图上所示的配置)</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190103-135046.png" alt="QQ20190103-135046"></span></p>
</div>
</div>
<div class="sect2">
<h3 id="redis配置"><a class="anchor" href="#redis配置"></a>Redis配置</h3>
<div class="paragraph">
<p>程序也内置了redis做缓存的功能</p>
</div>
<div class="paragraph">
<p>配置地址：启动程序 &#8594; 登录后台 &#8594; 系统设置</p>
</div>
<div class="paragraph">
<p>根据自己的环境配置上redis的信息，保存就可以用了，不用重启哦！！</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190103-154553.png" alt="QQ20190103-154553"></span></p>
</div>
</div>
<div class="sect2">
<h3 id="上传配置"><a class="anchor" href="#上传配置"></a>上传配置</h3>
<div class="paragraph">
<p>程序启动后，要配置上传文件保存路径，否则用户注册会看不到自己的头像</p>
</div>
<div class="paragraph">
<p>配置地址：启动程序 &#8594; 登录后台 &#8594; 系统设置</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190725-111655.png" alt="QQ20190725-111655"></span></p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<strong>路径一定要是绝对路径</strong>
</td>
</tr>
</table>
</div>
</div>
<div class="sect2">
<h3 id="非nginx静态映射配置"><a class="anchor" href="#非nginx静态映射配置"></a>非nginx静态映射配置</h3>
<div class="paragraph">
<p>如果你没有使用nginx做静态文件映射，就请配置在程序启动目录下，举个例子：</p>
</div>
<div class="paragraph">
<p>你下载的jar包存放在 <code>/opt/pybbs/pybbs.jar</code> 那么这里的地址就应该是 <code>/opt/pybbs/static/upload/</code></p>
</div>
<div class="paragraph">
<p>如果你用的是docker部署的服务，那这个路径配置就是固定的 <code>/app/static</code> 了，上传的图片会自动同步到docker启动目录下的static文件夹里</p>
</div>
</div>
<div class="sect2">
<h3 id="nginx静态文件映射配置方法"><a class="anchor" href="#nginx静态文件映射配置方法"></a>nginx静态文件映射配置方法</h3>
<div class="paragraph">
<p>nginx静态文件映射配置</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code>server {
  #...
  location /static/ {
    root /opt/cdn/;
    autoindex on;
  }
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>那么你这个地上的配置就应该是 <code>/opt/cdn/static/upload/</code></p>
</div>
</div>
<div class="sect2">
<h3 id="静态文件访问地址"><a class="anchor" href="#静态文件访问地址"></a>静态文件访问地址</h3>
<div class="paragraph">
<p>默认给的是 <code>http://localhost:8080/static/upload/</code> 如果你的访问域名是 <code>http://example.com</code> 那这里就要换成 <code>http://example.com/static/upload/</code></p>
</div>
</div>
<div class="sect2">
<h3 id="github登录配置方法"><a class="anchor" href="#github登录配置方法"></a>Github登录配置方法</h3>
<div class="paragraph">
<p>申请clientId, clientSecret地址：https://github.com/settings/developers 前提要先登录github</p>
</div>
<div class="paragraph">
<p>打开页面后，点击 <code>New OAuth APP</code> 按钮</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190107-135811.png" alt="QQ20190107-135811"></span></p>
</div>
<div class="paragraph">
<p>填上必要的信息</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190107-140155.png" alt="QQ20190107-140155"></span></p>
</div>
<div class="paragraph">
<p>填写好之后，保存，跳转的页面上就有 clientId, clientSecret信息了，如下图</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190107-135903.png" alt="QQ20190107-135903"></span></p>
</div>
<div class="paragraph">
<p>拷贝上图中红框内容，粘贴到网站后台系统设置页面里的 Github 配置信息里</p>
</div>
<div class="paragraph">
<p>刷新登录页面即可出现相应按钮</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190418-153321.png" alt="QQ20190418-153321"></span></p>
</div>
<div class="paragraph">
<p><strong>注意</strong></p>
</div>
<div class="ulist">
<ul>
<li>
<p>网站域名必须外网能访问，如是你要在内网测试，可以使用ngrok，frp等工具来做内网穿透，具体使用方法百度吧，网上很多</p>
</li>
<li>
<p>回调地址格式是 网站域名+/oauth/github/callback 假如你的域名是 <code>http://example.com</code> 那么这里的回调地址就是 <code>http://example.com/oauth/github/callback</code> 不要填错了</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>配置好之后，保存，再次回到首页，就可以看到页面 header 上就有了`Github登录`的入口了</p>
</div>
</div>
<div class="sect2">
<h3 id="微信登录配置方法"><a class="anchor" href="#微信登录配置方法"></a>微信登录配置方法</h3>
<div class="paragraph">
<p>注册开放平台 <a href="http://open.weixin.qq.com" class="bare">http://open.weixin.qq.com</a> 然后创建web应用，跟着步骤一步一步来就可以了，最后可以拿到 <code>appid</code> <code>appsecret</code> 加上在创建应用的时候填上的 <code>callback</code></p>
</div>
<div class="paragraph">
<p>总共三个参数，都配置在`朋也社区`后台设置页面里`微信登录`区域，然后刷新登录页面，就有微信登录按钮了！！</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190418-153321.png" alt="QQ20190418-153321"></span></p>
</div>
<div class="paragraph">
<p><strong>感谢 <a href="https://github.com/gdhua">@gdhua</a> 提供的微信联合登录要用到的 <code>appid</code> <code>appsecret</code></strong></p>
</div>
</div>
<div class="sect2">
<h3 id="短信验证码登录-注册"><a class="anchor" href="#短信验证码登录-注册"></a>短信验证码登录/注册</h3>
<div class="paragraph">
<p>在群友提供的阿里云短信的key, secret及模板的帮助下，朋也社区也有了短信验证码登录的功能了，配置如下</p>
</div>
<div class="paragraph">
<p>登录 <a href="http://aliyun.com" class="bare">http://aliyun.com</a> ，打开 <a href="https://dysms.console.aliyun.com/dysms.htm?spm=5176.8195934.1283918..623230c9cuQEpk#/domestic/text/sign" class="bare">https://dysms.console.aliyun.com/dysms.htm?spm=5176.8195934.1283918..623230c9cuQEpk#/domestic/text/sign</a> 链接</p>
</div>
<div class="paragraph">
<p>配置 <code>签名</code> <code>模板</code> <code>区域</code></p>
</div>
<div class="paragraph">
<p>然后在 <a href="https://usercenter.console.aliyun.com/?spm=5176.12207334.0.0.8dae1cbeSq0lnd#/manage/ak" class="bare">https://usercenter.console.aliyun.com/?spm=5176.12207334.0.0.8dae1cbeSq0lnd#/manage/ak</a> 这个页面拿到 <code>key</code> <code>secret</code></p>
</div>
<div class="paragraph">
<p>最后配置在项目后台的系统设置里，刷新登录页面，就会有手机号登录的按钮出现</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190418-153321.png" alt="QQ20190418-153321"></span></p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
<div class="paragraph">
<p>短信服务目前只支持阿里云短信服务</p>
</div>
<div class="paragraph">
<p>申请模板的时候，动态内容的变量名是 <code>${code}</code> 请不要写成其它的</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p><strong>感谢 <a href="https://github.com/sunkaifei">@sunkaifei</a> 提供的阿里云短信验证码登录要用到的 <code>key</code> <code>secret</code></strong></p>
</div>
</div>
<div class="sect2">
<h3 id="开启websocket"><a class="anchor" href="#开启websocket"></a>开启WebSocket</h3>
<div class="paragraph">
<p>重新更新了一下websocket的实现，换成了javax.websocket包下的类实现，没有了之间的关闭服务还要等会的问题了</p>
</div>
<div class="paragraph">
<p>而且页面上也不用再多引入一个socket.io的js了，纯原生的js实现</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<div class="paragraph">
<p>注意，因为网站是服务端渲染的，所以每次请求页面都会刷新，websocket也会重连，这就有点蛋疼了</p>
</div>
<div class="paragraph">
<p>不过也不是没办法, 可以给网站加上pjax支持，也可以将这个功能用在纯js渲染的网站上，很显然这两个功能pybbs都还没有</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>目前围绕ws开发的功能有如下</p>
</div>
<div class="ulist">
<ul>
<li>
<p>自己的话题被收藏了，会收到通知</p>
</li>
<li>
<p>自己的话题被评论了，会收到通知</p>
</li>
<li>
<p>自己的评论被回复了，会收到通知</p>
</li>
<li>
<p>进入页面后，ws会自动获取未读消息数，然后展示在页面上的Header和`document.title`上</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>效果如下</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/7C56195B1FE6F942649D30D65416EE80.jpg" alt="7C56195B1FE6F942649D30D65416EE80"></span></p>
</div>
<div class="paragraph">
<p>当然开启websocket服务也不是没有好处的，比如：</p>
</div>
<div class="ulist">
<ul>
<li>
<p>上图中别人回复了自己的评论就会立即收到消息</p>
</li>
<li>
<p>发一个帖子等着别人回复，不用一直刷新页面看有没有新消息了</p>
</li>
</ul>
</div>
<hr>
<div class="paragraph">
<p>如果你看了上面的说明后，还是想开启，配置如下</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190123-103144.png" alt="QQ20190123-103144"></span></p>
</div>
<div class="paragraph">
<p>只有两个配置</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>开启功能，不多说</p>
</li>
<li>
<p>ws连接地址，协议是 <code>ws</code> 或者 <code>wss</code>(如果你网站访问用的是https，那这个就应该是wss)，其它跟上面配置的网站访问域名一样</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>然后直接启动系统即可，注意，ws服务在前端只有登录后的用户才有效</p>
</div>
</div>
<div class="sect2">
<h3 id="内置主题"><a class="anchor" href="#内置主题"></a>内置主题</h3>
<div class="ulist">
<ul>
<li>
<p>default: 默认主题（使用Bootstrap3开发的）</p>
</li>
<li>
<p>simple: 黑白简洁主题（仿hacker news开发的, 有时候看着也挺像kindle风格的）</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="更换主题"><a class="anchor" href="#更换主题"></a>更换主题</h3>
<div class="paragraph">
<p>启动后，登录后台，可进行选择使用哪套，选择后保存，立即生效</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190131-173707.png" alt="QQ20190131-173707"></span></p>
</div>
<div class="paragraph">
<p>想体验的，可以在体验环境上修改查看</p>
</div>
<div class="paragraph">
<p>关于主题怎么开发，下一篇介绍</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="公网部署"><a class="anchor" href="#公网部署"></a>公网部署</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="部署步骤"><a class="anchor" href="#部署步骤"></a>部署步骤</h3>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>购买域名，域名提供商非常多，选一个自己喜欢的购买一个就可以了</p>
</li>
<li>
<p>去服务器运营商购买服务器，建议阿里云，购买的时候看清区域，国内做论坛 <strong>必须要备案的</strong> ，不过阿里云也有国外的节点，购买的时候请注意</p>
</li>
<li>
<p>安装java8，mysql5.7</p>
</li>
<li>
<p>按照 快速开始 中的部署方法部署</p>
</li>
</ol>
</div>
</div>
<div class="sect2">
<h3 id="nginx配置"><a class="anchor" href="#nginx配置"></a>nginx配置</h3>
<div class="paragraph">
<p>如果你服务器上就只一个论坛项目，那直接将程序里的端口改成80即可，如果你还想折腾点其它的东西，那就要用到nginx做代理转发请求了，具体配置如下</p>
</div>
<div class="paragraph">
<p>假如 example.com 是你的域名，程序启动端口是 8080 ，配置如下</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="nginx">server {
  server_name example.com;
  location / {
    proxy_pass http://127.0.0.1:8080/;
    proxy_redirect          off;
    proxy_set_header        Host            $host;
    proxy_set_header        X-Real-IP       $remote_addr;
    proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
    client_max_body_size    2m;
    client_body_buffer_size 128k;
    proxy_connect_timeout   300;
    proxy_send_timeout      300;
    proxy_read_timeout      300;
    proxy_buffers           32 32k;
    proxy_buffer_size       64k;
    proxy_busy_buffers_size 128k;
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="frp映射配置"><a class="anchor" href="#frp映射配置"></a>frp映射配置</h3>
<div class="paragraph">
<p>关于这个配置可以参见我的一篇博客 <a href="https://tomoya92.github.io/2018/10/18/frp-tutorial/">利用frp内网穿透实现用自家电脑发布网站(不用买服务器了)</a></p>
</div>
</div>
<div class="sect2">
<h3 id="配置https"><a class="anchor" href="#配置https"></a>配置https</h3>
<div class="paragraph">
<p>https强烈推荐使用 letsencrypt 配置简单，主要是免费，唯一的缺点就是要3个月续一下时间，配置参见文档: <a href="https://tomoya92.github.io/2016/08/28/letsencrypt-nginx-https/">letsencrypt结合nginx配置https备忘</a></p>
</div>
<div class="paragraph">
<p>配置外网环境运气好，很快就可以搭建好，运气不好，折腾两天是常事，淡定慢慢配</p>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
<strong>自己实在部署不好，朋也也可以代劳，不过是有偿的哦</strong>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="主题开发"><a class="anchor" href="#主题开发"></a>主题开发</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>开发主题，首先要会使用freemarker模板引擎, 因为pybbs的页面用的就是freemarker模式</strong></p>
</div>
<div class="paragraph">
<p>必要说明：</p>
</div>
<div class="ulist">
<ul>
<li>
<p>主题开发好了，需要放在 <code>src/main/resources/templates/theme</code> 下，系统启动会自动读取主题目录，然后在后台就可以选择你想要的主题了</p>
</li>
<li>
<p>如果你不是开发环境，那需要将开发好的或者下载的主题文件夹放在 <code>pybbs.jar</code> 所在目录下的 <code>templates/theme</code> 文件夹下，如果这两个文件夹没有，需要你创建好</p>
</li>
<li>
<p>开发主题肯定需要引入样式，建议使用 <code>cdnjs.com</code> 的外链，但也有一些对系统内的样式，这个样式文件需要放在 <code>pybbs.jar</code> 目录所在文件夹下的 <code>templates/static/theme/css</code> 文件夹下，js同理</p>
</li>
</ul>
</div>
<div class="sect2">
<h3 id="主题目录"><a class="anchor" href="#主题目录"></a>主题目录</h3>
<div class="paragraph">
<p>主题必备目录有以下几个</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code>simple
├── comment
├── tag
├── topic
└── user</code></pre>
</div>
</div>
<div class="paragraph">
<p>必备的文件有如下</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code>simple
├── comment
│   └── edit.ftl
├── error.ftl
├── index.ftl
├── login.ftl
├── notifications.ftl
├── register.ftl
├── search.ftl
├── tag
│   ├── tag.ftl
│   └── tags.ftl
├── top100.ftl
├── topic
│   ├── create.ftl
│   ├── detail.ftl
│   └── edit.ftl
└── user
    ├── collects.ftl
    ├── comments.ftl
    ├── profile.ftl
    ├── settings.ftl
    └── topics.ftl</code></pre>
</div>
</div>
<div class="paragraph">
<p><strong>注意，上面列出来的文件夹和文件都是必备的</strong></p>
</div>
<div class="paragraph">
<p>如果你习惯封装，可以跟default主题里一样，把通用的代码块封装成component，放在一个文件夹里（比如 default主题里的组件文件夹就是 components 当然这个不是必须的）</p>
</div>
</div>
<div class="sect2">
<h3 id="全局对象"><a class="anchor" href="#全局对象"></a>全局对象</h3>
<div class="paragraph">
<p>通俗点说就是在所有页面里都能取到的数据的对象，有如下几个</p>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">对象名</th>
<th class="tableblock halign-left valign-top">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">model</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">这个对象就是项目中类 BaseModel 的对象，所以使用这个对象可以调用BaseModel类中的所有方法</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">_user</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">这个对象是用户在登录或者注册成功后，将当前用户的对象存放在Session中的对象，只有在用户登录后才能获取到</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">site</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">这个对象就是后台系统配置中的那一堆东西</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">i18n</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">如果开发主题里要适配上国际化，可以使用这个对象来获取一些国际化菜单的不同语言的不同值</p></td>
</tr>
</tbody>
</table>
<div class="sect3">
<h4 id="model对象内的方法"><a class="anchor" href="#model对象内的方法"></a>model对象内的方法</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> formatDate(<span class="predefined-type">Date</span> date);
<span class="predefined-type">String</span> formatContent(<span class="predefined-type">String</span> content);
<span class="predefined-type">Set</span>&lt;<span class="predefined-type">String</span>&gt; getUpIds(<span class="predefined-type">String</span> upIds);
<span class="type">boolean</span> isEmpty(<span class="predefined-type">String</span> txt);</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="site对象中的属性"><a class="anchor" href="#site对象中的属性"></a>site对象中的属性</h4>
<div class="paragraph">
<p>在页面里取site里的属性方法 <code>${site.name!}</code></p>
</div>
<div class="paragraph">
<p>属性的类型全都是 String，可根据自己需要将值转成 int 或者 boolean</p>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">属性</th>
<th class="tableblock halign-left valign-top">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin_remember_me_max_age</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">登录后台记住我功能记住时间，单位：天</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">base_url</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">网站部署后访问的域名，注意这个后面没有 "/"</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">comment_layer</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">评论盖楼形式显示</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">cookie_domain</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">存cookie时用到的域名，要与网站部署后访问的域名一致</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">cookie_max_age</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">cookie有效期，单位秒，默认1周</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">cookie_name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">存cookie时用到的名称</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">intro</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">站点介绍</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">站点名称</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">page_size</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">分页每页条数</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">topic_view_increase_interval</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">同一个用户浏览同一个话题多长时间算一次浏览量，默认10分钟，单位秒（只有当配置了redis才会生效）</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">theme</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">系统主题</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">mail_host</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">邮箱的smtp服务器地址</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">mail_password</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">发送邮件的邮箱密码</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">mail_username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">发送邮件的邮箱地址</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">static_url</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">静态文件访问地址，主要用于上传图片的访问，注意最后有个"/"</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">upload_avatar_size_limit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">上传头像文件大小，单位MB，默认2MB</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">upload_path</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">上传文件的路径，注意最后有个"/"</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">create_comment_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">发布评论奖励的积分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">create_topic_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">创建话题奖励的积分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">delete_comment_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">删除评论要被扣除的积分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">delete_topic_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">删除话题要被扣除的积分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">up_comment_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">点赞评论奖励评论作者的积分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">up_topic_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">点赞话题奖励话题作者的积分</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis_host</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis服务host地址</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis_port</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis服务端口（默认: 6379）</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis_password</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis服务密码</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis_timeout</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">网站连接redis服务超时时间，单位毫秒</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis_database</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">网站连接redis服务的哪个数据库，默认0号数据库，取值范围0-15</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis_ssl</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">redis服务是否开启认证连接</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">elasticsearch_host</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">elasticsearch服务的地址</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">elasticsearch_port</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">elasticsearch服务的http端口</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">elasticsearch_index</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">索引的名字</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">search</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">是否开启搜索功能（如果开启，需要额外启动一个ES服务，并填好ES相关的配置）</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">oauth_github_client_id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Github登录配置项ClientId</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">oauth_github_client_secret</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Github登录配置项ClientSecret</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">oauth_github_callback_url</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Github登录配置项回调地址</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">websocket</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">是否开启websocket功能</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">websocket_host</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">websocket服务的主机名，这个跟cookie的域名设置成一样的就可以了</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">websocket_port</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">websocket服务的端口，不能跟论坛服务端口一样，其它随便设置</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect3">
<h4 id="i18n对象中的属性"><a class="anchor" href="#i18n对象中的属性"></a>i18n对象中的属性</h4>
<div class="paragraph">
<p>在页面中获取的方法是 <code>${i18n.getMessage("index")}</code></p>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">属性</th>
<th class="tableblock halign-left valign-top">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">index</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">首页</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">标签</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">search</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">搜索</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">login</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">登录</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">github_login</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Github登录</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">register</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">注册</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">notification</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">通知</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">setting</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">设置</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">logout</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">登出</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">welcome</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">欢迎您</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.dashboard</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">仪表盘</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.topics</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">话题列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.comments</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">评论列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.tags</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">标签列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.users</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.permission_config</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限中心</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.admin_users</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">后台用户列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.roles</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">角色列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.permissions</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">权限列表</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">admin.system_config</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">系统设置</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="sect2">
<h3 id="freemarker自定义标签"><a class="anchor" href="#freemarker自定义标签"></a>Freemarker自定义标签</h3>
<div class="paragraph">
<p>pybbs提供了如下几个自定义标签</p>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
<col style="width: 25%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">标签名</th>
<th class="tableblock halign-left valign-top">描述</th>
<th class="tableblock halign-left valign-top">参数</th>
<th class="tableblock halign-left valign-top">返回的对象(类型)</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_topics</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">话题列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">pageNo, tab</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">page(Page&lt;Map&lt;String, Object&gt;&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_other_topic</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">作者其它话题</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">userId, topicId, limit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topics(List&lt;Topic&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_notifications</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">通知列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">userId, read, limit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">notifications(List&lt;Map&lt;String, Object&gt;&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_score</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">积分排行</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">limit</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">users(List&lt;User&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_search</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">搜索结果列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">keyword, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">page(Page&lt;Map&lt;String, Object&gt;&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_tags</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">标签列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">pageNo, pageSize</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">page(Page&lt;Tag&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_user_topics</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户的话题列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo, pageSize</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topics(Page&lt;Map&lt;String, Object&gt;&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_user_comments</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户的评论列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo, pageSize</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">comments(Page&lt;Map&lt;String, Object&gt;&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_user_collects</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">用户的收藏列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo, pageSize</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">collects(Page&lt;Map&lt;String, Object&gt;&gt;)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag_topic_comments</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">话题的评论列表</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topicId</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">comments(List&lt;CommentsByTopic&gt;)</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>在标签返回对象里有一些不是定义的model里的对象，而是Map封装的对象，这些map里都有啥呢？</p>
</div>
<div class="sect3">
<h4 id="标签-tag_topics-对象中的map包含的字段"><a class="anchor" href="#标签-tag_topics-对象中的map包含的字段"></a>标签 tag_topics 对象中的Map包含的字段</h4>
<div class="ulist">
<ul>
<li>
<p>Topic t.*: Topic对象里的所有字段</p>
</li>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>avatar: 用户头像</p>
</li>
</ul>
</div>
</div>
<div class="sect3">
<h4 id="标签-tag_notifications-对象中的map包含的字段"><a class="anchor" href="#标签-tag_notifications-对象中的map包含的字段"></a>标签 tag_notifications 对象中的Map包含的字段</h4>
<div class="ulist">
<ul>
<li>
<p>Notification n.*: Notification对象里的所有字段</p>
</li>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>avatar: 用户头像</p>
</li>
<li>
<p>title: 话题标题</p>
</li>
<li>
<p>topicId: 话题ID</p>
</li>
</ul>
</div>
</div>
<div class="sect3">
<h4 id="标签-tag_search-对象中的map包含的字段"><a class="anchor" href="#标签-tag_search-对象中的map包含的字段"></a>标签 tag_search 对象中的Map包含的字段</h4>
<div class="ulist">
<ul>
<li>
<p>id: 话题ID</p>
</li>
<li>
<p>title: 话题标题</p>
</li>
<li>
<p>content: 话题内容</p>
</li>
</ul>
</div>
</div>
<div class="sect3">
<h4 id="标签-tag_user_topics-对象中的map包含的字段"><a class="anchor" href="#标签-tag_user_topics-对象中的map包含的字段"></a>标签 tag_user_topics 对象中的Map包含的字段</h4>
<div class="ulist">
<ul>
<li>
<p>Topic t.*: Topic对象里的所有字段</p>
</li>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>avatar: 用户头像</p>
</li>
</ul>
</div>
</div>
<div class="sect3">
<h4 id="标签-tag_user_comments-对象中的map包含的字段"><a class="anchor" href="#标签-tag_user_comments-对象中的map包含的字段"></a>标签 tag_user_comments 对象中的Map包含的字段</h4>
<div class="ulist">
<ul>
<li>
<p>Comment c.*: Comment对象里的所有字段</p>
</li>
<li>
<p>topicUsername: 话题的用户名</p>
</li>
<li>
<p>commentUsername: 话题的用户名</p>
</li>
<li>
<p>title: 话题标题</p>
</li>
<li>
<p>topicId: 话题ID</p>
</li>
</ul>
</div>
</div>
<div class="sect3">
<h4 id="标签-tag_user_collects-对象中的map包含的字段"><a class="anchor" href="#标签-tag_user_collects-对象中的map包含的字段"></a>标签 tag_user_collects 对象中的Map包含的字段</h4>
<div class="ulist">
<ul>
<li>
<p>Topic t.*: Topic对象里的所有字段</p>
</li>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>avatar: 用户头像</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2">
<h3 id="自定义标签使用"><a class="anchor" href="#自定义标签使用"></a>自定义标签使用</h3>
<div class="paragraph">
<p>自定义标签用法很简单，不会用的话，可以参考已经存在的主题里的用法，下面说一下首页的 tag_topics 标签的用法</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="html"><span class="error">&lt;</span>@tag_topics pageNo=pageNo tab=tab<span class="error">&gt;</span>
  // tag_topics 里的两个参数都是从controller里传过来的
  // 在标签内部就可以拿到自定义标签返回的对象了，比如这个标签返回的就一个page对象
  <span class="error">&lt;</span>#list page.records as topic<span class="error">&gt;</span>
    <span class="tag">&lt;p&gt;</span>${topic.title}<span class="tag">&lt;/p&gt;</span>
  <span class="tag">&lt;/</span>#list<span class="error">&gt;</span>
<span class="tag">&lt;/</span>@tag_topics<span class="error">&gt;</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>至于标签里返回的对象都是什么东西，下面介绍，先说说每个路由渲染的页面里都能取出什么东西吧</p>
</div>
</div>
<div class="sect2">
<h3 id="路由渲染可获取对象"><a class="anchor" href="#路由渲染可获取对象"></a>路由渲染可获取对象</h3>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 20%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">地址</th>
<th class="tableblock halign-left valign-top">类名</th>
<th class="tableblock halign-left valign-top">参数</th>
<th class="tableblock halign-left valign-top">放在model中对象</th>
<th class="tableblock halign-left valign-top">渲染视图文件名</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tab, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tab, active, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">index.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/top100</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">top100.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/settings</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">user</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">user/settings.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/tags</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag/tags.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/login</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">login.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/register</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">register.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/notifications</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">notifications.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/logout</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">重定向到首页</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/search</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">pageNo, keyword</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">pageNo, keyword</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">search.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/changeLanguage</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">lang: zh, cn</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">重定向到之前页面首页</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/active</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">IndexController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">email, code</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">激活成功后重定向到</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/user/{username}</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">UserController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">githubLogin, user, username, oAuthUsers, collectCount</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">user/profile.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/user/{username}/topics</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">UserController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">user/topics.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/user/{username}/comments</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">UserController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">user/comments.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/user/{username}/collects</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">UserController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">username, pageNo</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">user/collects.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/topic/{id}</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">TopicController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">collect, topic, tags, topicUser, collects</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topic/detail.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/topic/create</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">TopicController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topic/create.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/topic/edit/{id}</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">TopicController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topic, tags</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">topic/edit.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/topic/tag/{name}</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">TopicController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag, page</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">tag/tag.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/comment/edit/{id}</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CommentController</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">comment, topic</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">comment/edit.ftl</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/common/captcha</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">CommonController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">响应的是一张图片验证码的流</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">/oauth/github</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">OAuthController</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">重定向到Github授权页面，授权完成自动回调</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="对象包含的字段"><a class="anchor" href="#对象包含的字段"></a>对象包含的字段</h3>
<div class="sect3">
<h4 id="分页对象-page"><a class="anchor" href="#分页对象-page"></a>分页对象 Page</h4>
<div class="paragraph">
<p>这个对象是Mybatis-Plus里封装的，常用字段有以下几个</p>
</div>
<div class="ulist">
<ul>
<li>
<p>List records: 查询出来的列表放在这个里面，类型是个List</p>
</li>
<li>
<p>long current: 当前是第几页，从1开始</p>
</li>
<li>
<p>long total: 总条数</p>
</li>
<li>
<p>long pages: 总页数</p>
</li>
<li>
<p>long size: 每页显示条数</p>
</li>
</ul>
</div>
</div>
<div class="sect3">
<h4 id="用户对象-user"><a class="anchor" href="#用户对象-user"></a>用户对象 User</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> <span class="predefined-type">Integer</span> id;
<span class="directive">private</span> <span class="predefined-type">String</span> username;
<span class="directive">private</span> <span class="predefined-type">String</span> telegramName;
<span class="directive">private</span> <span class="predefined-type">String</span> avatar;
<span class="directive">private</span> <span class="predefined-type">String</span> password;
<span class="directive">private</span> <span class="predefined-type">String</span> email;
<span class="comment">// 个人网站</span>
<span class="directive">private</span> <span class="predefined-type">String</span> website;
<span class="comment">// 个人简介</span>
<span class="directive">private</span> <span class="predefined-type">String</span> bio;
<span class="directive">private</span> <span class="predefined-type">Integer</span> score;
<span class="directive">private</span> <span class="predefined-type">Date</span> inTime;
<span class="directive">private</span> <span class="predefined-type">String</span> token;
<span class="comment">// 有消息通知是否通过邮箱收取</span>
<span class="directive">private</span> <span class="predefined-type">Boolean</span> emailNotification;
<span class="comment">// 帐号的激活状态</span>
<span class="directive">private</span> <span class="predefined-type">Boolean</span> active;</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="话题对象-topic"><a class="anchor" href="#话题对象-topic"></a>话题对象 Topic</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> <span class="predefined-type">Integer</span> id;
<span class="directive">private</span> <span class="predefined-type">String</span> title;
<span class="directive">private</span> <span class="predefined-type">String</span> content;
<span class="directive">private</span> <span class="predefined-type">Date</span> inTime;
<span class="directive">private</span> <span class="predefined-type">Date</span> modifyTime;
<span class="directive">private</span> <span class="predefined-type">Integer</span> userId;
<span class="comment">// 评论数</span>
<span class="directive">private</span> <span class="predefined-type">Integer</span> commentCount;
<span class="comment">// 收藏数</span>
<span class="directive">private</span> <span class="predefined-type">Integer</span> collectCount;
<span class="comment">// 浏览数</span>
<span class="directive">private</span> <span class="predefined-type">Integer</span> view;
<span class="comment">// 置顶</span>
<span class="directive">private</span> <span class="predefined-type">Boolean</span> top;
<span class="comment">// 加精</span>
<span class="directive">private</span> <span class="predefined-type">Boolean</span> good;
<span class="comment">// 点赞用户的id英文,隔开的，要计算被多少人点赞过，可以通过英文,分隔这个字符串计算数量</span>
<span class="directive">private</span> <span class="predefined-type">String</span> upIds;</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="评论对象-comment"><a class="anchor" href="#评论对象-comment"></a>评论对象 Comment</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> <span class="predefined-type">Integer</span> id;
<span class="directive">private</span> <span class="predefined-type">Integer</span> topicId;
<span class="directive">private</span> <span class="predefined-type">Integer</span> userId;
<span class="directive">private</span> <span class="predefined-type">String</span> content;
<span class="directive">private</span> <span class="predefined-type">Date</span> inTime;
<span class="directive">private</span> <span class="predefined-type">Integer</span> commentId;
<span class="comment">// 点赞用户的id</span>
<span class="directive">private</span> <span class="predefined-type">String</span> upIds;</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="评论-盖楼-对象-commentsbytopic"><a class="anchor" href="#评论-盖楼-对象-commentsbytopic"></a>评论(盖楼)对象 CommentsByTopic</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="comment">// 话题下面的评论列表单个对象的数据结构</span>
<span class="directive">public</span> <span class="type">class</span> <span class="class">CommentsByTopic</span> <span class="directive">extends</span> Comment <span class="directive">implements</span> <span class="predefined-type">Serializable</span> {

  <span class="directive">private</span> <span class="predefined-type">String</span> username;
  <span class="directive">private</span> <span class="predefined-type">String</span> avatar;
  <span class="comment">// 评论的层级，直接评论话题的，layer即为0，如果回复了评论的，则当前回复的layer为评论对象的layer+1</span>
  <span class="directive">private</span> <span class="predefined-type">Integer</span> layer;
}</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="通知对象-notification"><a class="anchor" href="#通知对象-notification"></a>通知对象 Notification</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> <span class="predefined-type">Integer</span> id;
<span class="directive">private</span> <span class="predefined-type">Integer</span> topicId;
<span class="directive">private</span> <span class="predefined-type">Integer</span> userId;
<span class="comment">// 通知对象ID</span>
<span class="directive">private</span> <span class="predefined-type">Integer</span> targetUserId;
<span class="comment">// 动作: REPLY, COMMENT, COLLECT, TOPIC_UP, COMMENT_UP</span>
<span class="directive">private</span> <span class="predefined-type">String</span> action;
<span class="directive">private</span> <span class="predefined-type">Date</span> inTime;
<span class="directive">private</span> <span class="predefined-type">String</span> content;
<span class="comment">// 是否已读</span>
<span class="directive">private</span> <span class="predefined-type">Boolean</span> read;</code></pre>
</div>
</div>
</div>
<div class="sect3">
<h4 id="授权登录对象-oauthuser"><a class="anchor" href="#授权登录对象-oauthuser"></a>授权登录对象 OAuthUser</h4>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> <span class="predefined-type">Integer</span> id;
<span class="comment">// oauth帐号的id</span>
<span class="directive">private</span> <span class="predefined-type">Integer</span> oauthId;
<span class="comment">// 帐号类型，GITHUB, QQ, WECHAT, WEIBO 等</span>
<span class="directive">private</span> <span class="predefined-type">String</span> type;
<span class="comment">// oauth帐号的登录名</span>
<span class="directive">private</span> <span class="predefined-type">String</span> login;
<span class="directive">private</span> <span class="predefined-type">String</span> accessToken;
<span class="directive">private</span> <span class="predefined-type">Date</span> inTime;
<span class="comment">// 个人简介</span>
<span class="directive">private</span> <span class="predefined-type">String</span> bio;
<span class="directive">private</span> <span class="predefined-type">String</span> email;
<span class="comment">// 本地用户的id</span>
<span class="directive">private</span> <span class="predefined-type">Integer</span> userId;</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="接口文档"><a class="anchor" href="#接口文档"></a>接口文档</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="获取token"><a class="anchor" href="#获取token"></a>获取token</h3>
<div class="paragraph">
<p><strong>系统默认开启了cors访问，任何源都可以访问 <code>/api/**</code> 下的资源，如果想关闭的话，可以通过修改源码的方式关闭，源码位置 <code>co.yiiu.pybbs.config.WebMvcConfig</code></strong></p>
</div>
<div class="paragraph">
<p>有的接口请求要求带上用户的`token`参数，这个token是在用户注册的时候自动生成的，可以在个人设置页面重新生成</p>
</div>
<div class="paragraph">
<p>token的获取方式：</p>
</div>
<div class="paragraph">
<p>用户登录上论坛，打开页面最上方的 设置，在页面右边可以查看到自己的token，如下图</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/QQ20190109-111822.png" alt="QQ20190109-111822"></span></p>
</div>
</div>
<div class="sect2">
<h3 id="请求接口示例"><a class="anchor" href="#请求接口示例"></a>请求接口示例</h3>
<div class="paragraph">
<p>pybbs上的接口风格已经全都换成`RESTFUL`风格的了，调用方式也有了相应的调整</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>所有需要传token的接口，token参数要放在请求头里(headers)</p>
</li>
<li>
<p>所有需要传参数的接口，参数都以 json 的形式传递</p>
</li>
<li>
<p>请求不单单是get, post了，还加入了put, delete，请仔细查看接口文档</p>
</li>
</ol>
</div>
<div class="paragraph">
<p>下面给一个发帖的jQuery调用示例:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="js"><span class="predefined">$</span>.ajax({
  <span class="key">url</span>: <span class="string"><span class="delimiter">'</span><span class="content">/api/topic</span><span class="delimiter">'</span></span>,
  <span class="key">type</span>: <span class="string"><span class="delimiter">'</span><span class="content">post</span><span class="delimiter">'</span></span>,
  <span class="key">cache</span>: <span class="predefined-constant">false</span>,
  <span class="key">async</span>: <span class="predefined-constant">false</span>,
  <span class="key">headers</span>: {
    <span class="key"><span class="delimiter">'</span><span class="content">token</span><span class="delimiter">'</span></span>: <span class="string"><span class="delimiter">'</span><span class="content">8f2e6b0d-5a7a-44eb-9c96-4f87d55c212e</span><span class="delimiter">'</span></span>
  },
  <span class="key">contentType</span>: <span class="string"><span class="delimiter">'</span><span class="content">application/json</span><span class="delimiter">'</span></span>,
  <span class="key">data</span>: JSON.stringify({
    <span class="key">title</span>: title,
    <span class="key">content</span>: content,
    <span class="key">tags</span>: tags,
  }),
  <span class="function">success</span>: <span class="keyword">function</span>(data) {
    <span class="keyword">if</span> (data.code === <span class="integer">200</span>) {
      window.location.href = <span class="string"><span class="delimiter">&quot;</span><span class="content">/topic/</span><span class="delimiter">&quot;</span></span> + data.detail.id
    } <span class="keyword">else</span> {
      alert(data.description);
    }
  }
})</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="接口返回对象"><a class="anchor" href="#接口返回对象"></a>接口返回对象</h3>
<div class="paragraph">
<p>接口返回对象就只有一个 <code>Result</code></p>
</div>
<div class="paragraph">
<p>这个类是在程序里自定义的，共三个属性</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">Result</span> {

  <span class="directive">private</span> <span class="predefined-type">Integer</span> code;
  <span class="directive">private</span> <span class="predefined-type">String</span> description;
  <span class="directive">private</span> <span class="predefined-type">Object</span> detail;

  <span class="comment">// getter, setter</span>
}</code></pre>
</div>
</div>
<div class="ulist">
<ul>
<li>
<p>code : 返回时的状态值，成功：200， 失败：201</p>
</li>
<li>
<p>description: 失败时的一些描述信息放在这个属性里</p>
</li>
<li>
<p>detail: 一般放成功后的返回值，它是一个Object类型的属性，可以放任何对象</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="接口返回分页对象"><a class="anchor" href="#接口返回分页对象"></a>接口返回分页对象</h3>
<div class="paragraph">
<p>如果接口涉及到分页的话，就会返回 <code>Result(IPage)</code> 就是将查询后封装好的分页对象放在Result对象的detail属性里，再转成json返给前端</p>
</div>
<div class="paragraph">
<p>IPage对象是MyBatis-Plus内置的一个分页对象，其中调用接口可能会用到的属性有如下几个</p>
</div>
<div class="ulist">
<ul>
<li>
<p>records: 查询出的列表对象</p>
</li>
<li>
<p>pages: 分页后的总页数</p>
</li>
<li>
<p>total: 总条数</p>
</li>
<li>
<p>current: 当前页数</p>
</li>
<li>
<p>size: 每页条数</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>遗憾的是它没有像jpa那样封装两个属性 <code>last</code> <code>next</code> 这样就可以直接拿它们的值来判断是不是第一页或最后一页了</p>
</div>
<div class="paragraph">
<p>不过也可以通过 <code>current</code> 和 <code>pages</code> 来判断是第一页还是最后一页</p>
</div>
</div>
<div class="sect2">
<h3 id="图片验证码"><a class="anchor" href="#图片验证码"></a>图片验证码</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/common/captcha</code></p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>无</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 GIF图片</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>响应是一张GIF动态图片，如下图</p>
</div>
<div class="paragraph">
<p><span class="image"><img src="./images/captcha.gif" alt="captcha"></span></p>
</div>
<div class="paragraph">
<p>首页接口分别有以下几个</p>
</div>
</div>
<div class="sect2">
<h3 id="首页-首页列表"><a class="anchor" href="#首页-首页列表"></a>首页 - 首页列表</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/</code> 或者 <code>/api/index</code></p>
</li>
<li>
<p>请求类型 application/x-www-form-urlencoded</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>pageNo: 页码</p>
</li>
<li>
<p>tab: 分类，分别是 精华：<code>good</code> 无人评论：<code>noanswer</code> 热门：<code>hot</code> 最新：<code>newest</code></p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(IPage&lt;Map&gt;)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>:<span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>:{
    <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>:[
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>:<span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>:<span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">我是话题内容</span><span class="char">\n</span><span class="char">\n</span><span class="content">我还支持Markdown语法哦</span><span class="char">\n</span><span class="char">\n</span><span class="content">![](https://avatars3.githubusercontent.com/u/6915570?s=460&amp;v=4)</span><span class="char">\n</span><span class="char">\n</span><span class="content">- 无序列表1</span><span class="char">\n</span><span class="content">- 无序列表2</span><span class="char">\n</span><span class="content">- 无序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">1. 有序列表1</span><span class="char">\n</span><span class="content">2. 有序列表2</span><span class="char">\n</span><span class="content">3. 有序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">| Column A | Column B | Column C |</span><span class="char">\n</span><span class="content">| -------- | -------- | -------- |</span><span class="char">\n</span><span class="content">| A1       | B1       | C1       |</span><span class="char">\n</span><span class="content">| A2       | B2       | C2       |</span><span class="char">\n</span><span class="content">| A3       | B3       | C3       |</span><span class="char">\n</span><span class="char">\n</span><span class="content">[开发俱乐部](https://17dev.club/)</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>:<span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">tags</span><span class="delimiter">&quot;</span></span>:[
          {
            <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>,
            <span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">一个标签</span><span class="delimiter">&quot;</span></span>,
            <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>:<span class="value">null</span>,
            <span class="key"><span class="delimiter">&quot;</span><span class="content">icon</span><span class="delimiter">&quot;</span></span>:<span class="value">null</span>,
            <span class="key"><span class="delimiter">&quot;</span><span class="content">topicCount</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>,
            <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>:<span class="integer">1548992281000</span>
          }
        ],
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>:<span class="integer">1548992281000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>:<span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>:<span class="integer">1548992296000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>:<span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>:<span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>
      }
    ],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>:<span class="integer">20</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>:<span class="value">true</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>:<span class="integer">1</span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="首页-登录"><a class="anchor" href="#首页-登录"></a>首页 - 登录</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/login</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>password: 密码</p>
</li>
<li>
<p>captcha: 图片验证码</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">10</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992041000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">token</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">208bb4c1-daf1-4a32-b198-7f4db8f6d565</span><span class="delimiter">&quot;</span></span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="首页-注册"><a class="anchor" href="#首页-注册"></a>首页 - 注册</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/register</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>password: 密码</p>
</li>
<li>
<p>email: 邮箱地址</p>
</li>
<li>
<p>captcha: 图片验证码</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992486000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">token</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">b7ee4a41-48d9-4185-9ab7-bcd202719ded</span><span class="delimiter">&quot;</span></span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="首页-发送手机验证码"><a class="anchor" href="#首页-发送手机验证码"></a>首页 - 发送手机验证码</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/send_code</code></p>
</li>
<li>
<p>请求类型 application/x-www-form-urlencoded</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>mobile: 手机号</p>
</li>
<li>
<p>captcha: 图片验证码</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="首页-手机号-验证码登录-注册"><a class="anchor" href="#首页-手机号-验证码登录-注册"></a>首页 - 手机号+验证码登录/注册</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/mobile_login</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>mobile: 手机号</p>
</li>
<li>
<p>code: 手机验证码</p>
</li>
<li>
<p>captcha: 图片验证码</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">mobile</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">13111111111</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992486000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">token</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">b7ee4a41-48d9-4185-9ab7-bcd202719ded</span><span class="delimiter">&quot;</span></span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="首页-标签"><a class="anchor" href="#首页-标签"></a>首页 - 标签</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/tags</code></p>
</li>
<li>
<p>请求类型 application/x-www-form-urlencoded</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>pageNo</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(List&lt;Tag&gt;)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">一个标签</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">标签描述，解释一下标签让人能更明白它的意思</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">icon</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://spring.io/img/homepage/icon-spring-boot.svg</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>
      }
    ],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="首页-上传文件-图片-视频"><a class="anchor" href="#首页-上传文件-图片-视频"></a>首页 - 上传文件（图片，视频）</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/upload</code></p>
</li>
<li>
<p>请求类型 application/form-data</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>file: 上传图片的文件对象，支持多个文件, 多个文件就在formData里多次添加 <code>formData.append("file", file);</code></p>
</li>
<li>
<p>type: 上传图片的类型，如果上传头像请填 <code>avatar</code>，如果是发帖上传图片请填 <code>topic</code>，如果是视频请填 <code>video</code></p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(String) // 上传成功后，会返回图片的访问地址</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">errors</span><span class="delimiter">&quot;</span></span>: [],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">urls</span><span class="delimiter">&quot;</span></span>: [<span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>]
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="话题-话题详情"><a class="anchor" href="#话题-话题详情"></a>话题 - 话题详情</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/topic/:id</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token: <strong>可不传</strong>，传token返回值里会多一个这个话题是否被自己收藏，如果不填就没有这个对象</p>
</li>
<li>
<p>id: 话题id</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">comments</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">modify_comment_content</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992961000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">commentId</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">2</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">layer</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>
      },
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">5</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">@tomoya 我是第三条评论</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548993369000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">commentId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">layer</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
      },
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">4</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是第二条评论</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548993303000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">commentId</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">layer</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>
      }
    ],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">topic</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是话题内容</span><span class="char">\n</span><span class="char">\n</span><span class="content">我还支持Markdown语法哦</span><span class="char">\n</span><span class="char">\n</span><span class="content">![](https://avatars3.githubusercontent.com/u/6915570?s=460&amp;v=4)</span><span class="char">\n</span><span class="char">\n</span><span class="content">- 无序列表1</span><span class="char">\n</span><span class="content">- 无序列表2</span><span class="char">\n</span><span class="content">- 无序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">1. 有序列表1</span><span class="char">\n</span><span class="content">2. 有序列表2</span><span class="char">\n</span><span class="content">3. 有序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">| Column A | Column B | Column C |</span><span class="char">\n</span><span class="content">| -------- | -------- | -------- |</span><span class="char">\n</span><span class="content">| A1       | B1       | C1       |</span><span class="char">\n</span><span class="content">| A2       | B2       | C2       |</span><span class="char">\n</span><span class="content">| A3       | B3       | C3       |</span><span class="char">\n</span><span class="char">\n</span><span class="content">[开发俱乐部](https://17dev.club/)</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992296000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">4</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>: <span class="integer">13</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">topicUser</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992041000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">collect</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548999420000</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">collects</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548999420000</span>
      }
    ],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">tags</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">一个标签</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">标签描述，解释一下标签让人能更明白它的意思</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">icon</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://spring.io/img/homepage/icon-spring-boot.svg</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>
      }
    ]
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="话题-发布话题"><a class="anchor" href="#话题-发布话题"></a>话题 - 发布话题</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/topic</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>title: 话题标题</p>
</li>
<li>
<p>content: 话题内容（可为空）</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Topic)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
    <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>:  {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">11</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">222</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1551063711700</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
    }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="话题-编辑话题"><a class="anchor" href="#话题-编辑话题"></a>话题 - 编辑话题</h3>
<div class="ulist">
<ul>
<li>
<p>地址 PUT <code>/api/topic</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>id: 话题ID</p>
</li>
<li>
<p>title: 话题标题</p>
</li>
<li>
<p>content: 话题内容（可为空）</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Topic)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
    <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">11</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">333</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1551063712000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1551064039058</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>: <span class="integer">0</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
    }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="话题-删除话题"><a class="anchor" href="#话题-删除话题"></a>话题 - 删除话题</h3>
<div class="ulist">
<ul>
<li>
<p>地址 DELETE <code>/api/topic</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>id: 话题ID</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="话题-点赞话题"><a class="anchor" href="#话题-点赞话题"></a>话题 - 点赞话题</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/topic/:id/vote</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>id: 话题ID</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(int) 返回点赞后当前话题的总赞数</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="评论-发布评论"><a class="anchor" href="#评论-发布评论"></a>评论 - 发布评论</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/comment</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>content: 评论的内容</p>
</li>
<li>
<p>topicId: 评论的话题ID</p>
</li>
<li>
<p>commentId: 回复评论的对象（盖楼评论的上级评论id）</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Comment)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个评论</span><span class="delimiter">&quot;</span></span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992997521</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">commentId</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="评论-更新评论"><a class="anchor" href="#评论-更新评论"></a>评论 - 更新评论</h3>
<div class="ulist">
<ul>
<li>
<p>地址 PUT <code>/api/comment/:id</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>id: 评论的id</p>
</li>
<li>
<p>content: 评论的内容</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Comment)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是更新后的评论</span><span class="delimiter">&quot;</span></span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548993059477</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">commentId</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="评论-删除评论"><a class="anchor" href="#评论-删除评论"></a>评论 - 删除评论</h3>
<div class="ulist">
<ul>
<li>
<p>地址 DELETE <code>/api/comment/:id</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>id: 评论的id</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="评论-点赞评论"><a class="anchor" href="#评论-点赞评论"></a>评论 - 点赞评论</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/comment/:id/vote</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>id: 评论的id</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(int) 返回点赞后当前评论的总赞数</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="收藏-收藏话题"><a class="anchor" href="#收藏-收藏话题"></a>收藏 - 收藏话题</h3>
<div class="ulist">
<ul>
<li>
<p>地址 POST <code>/api/collect/:topicId</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>topicId: 话题ID</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="收藏-取消收藏"><a class="anchor" href="#收藏-取消收藏"></a>收藏 - 取消收藏</h3>
<div class="ulist">
<ul>
<li>
<p>地址 DELETE <code>/api/collect/:topicId</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>topicId: 话题ID</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="通知-未读消息个数"><a class="anchor" href="#通知-未读消息个数"></a>通知 - 未读消息个数</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/notification/notRead</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(int) // 返回未读消息条数</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="通知-标记消息已读"><a class="anchor" href="#通知-标记消息已读"></a>通知 - 标记消息已读</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/notification/markRead</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="通知-消息列表"><a class="anchor" href="#通知-消息列表"></a>通知 - 消息列表</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/notification/list</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">read</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548993303000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">read</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">action</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">COMMENT</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">targetUserId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是第二条评论</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>
      }
    ],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">notRead</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548993369000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">read</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">action</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">REPLY</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">targetUserId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">@tomoya 我是第三条评论</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>
      },
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548993369000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">read</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">action</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">COMMENT</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">targetUserId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">3</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/test/avatar.png</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">@tomoya 我是第三条评论</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">test</span><span class="delimiter">&quot;</span></span>
      }
    ]
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="用户-用户信息"><a class="anchor" href="#用户-用户信息"></a>用户 - 用户信息</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/user/:username</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>username: 用户名</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
<div class="ulist">
<ul>
<li>
<p>用户信息</p>
</li>
<li>
<p>话题列表（7条）</p>
</li>
<li>
<p>评论列表（7条）</p>
</li>
<li>
<p>收藏条数</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">oAuthUsers</span><span class="delimiter">&quot;</span></span>: [
      {
        <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">oauthId</span><span class="delimiter">&quot;</span></span>: <span class="integer">6915570</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">type</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">GITHUB</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">login</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya92</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548734221000</span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">hello world</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">py2qiuse@gmail.com</span><span class="delimiter">&quot;</span></span>,
        <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
      }
    ],
    <span class="key"><span class="delimiter">&quot;</span><span class="content">comments</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>: [
        {
          <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992961000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">commentUsername</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">2</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">topicUsername</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">modify_comment_content</span><span class="delimiter">&quot;</span></span>
        }
      ],
      <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>: <span class="integer">10</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">topics</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>: [
        {
          <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是话题内容</span><span class="char">\n</span><span class="char">\n</span><span class="content">我还支持Markdown语法哦</span><span class="char">\n</span><span class="char">\n</span><span class="content">![](https://avatars3.githubusercontent.com/u/6915570?s=460&amp;v=4)</span><span class="char">\n</span><span class="char">\n</span><span class="content">- 无序列表1</span><span class="char">\n</span><span class="content">- 无序列表2</span><span class="char">\n</span><span class="content">- 无序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">1. 有序列表1</span><span class="char">\n</span><span class="content">2. 有序列表2</span><span class="char">\n</span><span class="content">3. 有序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">| Column A | Column B | Column C |</span><span class="char">\n</span><span class="content">| -------- | -------- | -------- |</span><span class="char">\n</span><span class="content">| A1       | B1       | C1       |</span><span class="char">\n</span><span class="content">| A2       | B2       | C2       |</span><span class="char">\n</span><span class="content">| A3       | B3       | C3       |</span><span class="char">\n</span><span class="char">\n</span><span class="content">[开发俱乐部](https://17dev.club/)</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">4</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992296000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">2</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>
        }
      ],
      <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>: <span class="integer">10</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">py2qiuse@gmail.com</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">https://17dev.club/</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">hello world</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992041000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    }
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="用户-用户话题列表"><a class="anchor" href="#用户-用户话题列表"></a>用户 - 用户话题列表</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/user/:username/topics</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>pageNo: 页数</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">topics</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>: [
        {
          <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是话题内容</span><span class="char">\n</span><span class="char">\n</span><span class="content">我还支持Markdown语法哦</span><span class="char">\n</span><span class="char">\n</span><span class="content">![](https://avatars3.githubusercontent.com/u/6915570?s=460&amp;v=4)</span><span class="char">\n</span><span class="char">\n</span><span class="content">- 无序列表1</span><span class="char">\n</span><span class="content">- 无序列表2</span><span class="char">\n</span><span class="content">- 无序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">1. 有序列表1</span><span class="char">\n</span><span class="content">2. 有序列表2</span><span class="char">\n</span><span class="content">3. 有序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">| Column A | Column B | Column C |</span><span class="char">\n</span><span class="content">| -------- | -------- | -------- |</span><span class="char">\n</span><span class="content">| A1       | B1       | C1       |</span><span class="char">\n</span><span class="content">| A2       | B2       | C2       |</span><span class="char">\n</span><span class="content">| A3       | B3       | C3       |</span><span class="char">\n</span><span class="char">\n</span><span class="content">[开发俱乐部](https://17dev.club/)</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">4</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992296000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">2</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>
        }
      ],
      <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">py2qiuse@gmail.com</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">https://17dev.club/</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">hello world</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992041000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    }
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="用户-用户评论列表"><a class="anchor" href="#用户-用户评论列表"></a>用户 - 用户评论列表</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/user/:username/comments</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>pageNo: 页数</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">comments</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>: [
        {
          <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992961000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">topicId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">commentUsername</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">2</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">topicUsername</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">modify_comment_content</span><span class="delimiter">&quot;</span></span>
        }
      ],
      <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">py2qiuse@gmail.com</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">https://17dev.club/</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">hello world</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992041000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    }
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="用户-用户收藏列表"><a class="anchor" href="#用户-用户收藏列表"></a>用户 - 用户收藏列表</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/user/:username/collects</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>username: 用户名</p>
</li>
<li>
<p>pageNo: 页数</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(Map)</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: {
    <span class="key"><span class="delimiter">&quot;</span><span class="content">user</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">telegramName</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">email</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">py2qiuse@gmail.com</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">website</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">https://17dev.club/</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">bio</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">hello world</span><span class="delimiter">&quot;</span></span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">score</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992041000</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">emailNotification</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>
    },
    <span class="key"><span class="delimiter">&quot;</span><span class="content">collects</span><span class="delimiter">&quot;</span></span>: {
      <span class="key"><span class="delimiter">&quot;</span><span class="content">records</span><span class="delimiter">&quot;</span></span>: [
        {
          <span class="key"><span class="delimiter">&quot;</span><span class="content">collectCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">2</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://localhost:8080/static/upload/avatar/tomoya/avatar.png</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">title</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是一个话题标题</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">userId</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">good</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">content</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">我是话题内容</span><span class="char">\n</span><span class="char">\n</span><span class="content">我还支持Markdown语法哦</span><span class="char">\n</span><span class="char">\n</span><span class="content">![](https://avatars3.githubusercontent.com/u/6915570?s=460&amp;v=4)</span><span class="char">\n</span><span class="char">\n</span><span class="content">- 无序列表1</span><span class="char">\n</span><span class="content">- 无序列表2</span><span class="char">\n</span><span class="content">- 无序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">1. 有序列表1</span><span class="char">\n</span><span class="content">2. 有序列表2</span><span class="char">\n</span><span class="content">3. 有序列表3</span><span class="char">\n</span><span class="char">\n</span><span class="content">| Column A | Column B | Column C |</span><span class="char">\n</span><span class="content">| -------- | -------- | -------- |</span><span class="char">\n</span><span class="content">| A1       | B1       | C1       |</span><span class="char">\n</span><span class="content">| A2       | B2       | C2       |</span><span class="char">\n</span><span class="content">| A3       | B3       | C3       |</span><span class="char">\n</span><span class="char">\n</span><span class="content">[开发俱乐部](https://17dev.club/)</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">commentCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">4</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">tags</span><span class="delimiter">&quot;</span></span>: [
            {
              <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
              <span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">一个标签</span><span class="delimiter">&quot;</span></span>,
              <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">标签描述，解释一下标签让人能更明白它的意思</span><span class="delimiter">&quot;</span></span>,
              <span class="key"><span class="delimiter">&quot;</span><span class="content">icon</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">http://spring.io/img/homepage/icon-spring-boot.svg</span><span class="delimiter">&quot;</span></span>,
              <span class="key"><span class="delimiter">&quot;</span><span class="content">topicCount</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
              <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>
            }
          ],
          <span class="key"><span class="delimiter">&quot;</span><span class="content">inTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992281000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">view</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">modifyTime</span><span class="delimiter">&quot;</span></span>: <span class="integer">1548992296000</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">top</span><span class="delimiter">&quot;</span></span>: <span class="value">false</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">upIds</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">2</span><span class="delimiter">&quot;</span></span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
          <span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">tomoya</span><span class="delimiter">&quot;</span></span>
        }
      ],
      <span class="key"><span class="delimiter">&quot;</span><span class="content">total</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">size</span><span class="delimiter">&quot;</span></span>: <span class="integer">20</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">current</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">searchCount</span><span class="delimiter">&quot;</span></span>: <span class="value">true</span>,
      <span class="key"><span class="delimiter">&quot;</span><span class="content">pages</span><span class="delimiter">&quot;</span></span>: <span class="integer">1</span>
    }
  }
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="设置-更新个人信息"><a class="anchor" href="#设置-更新个人信息"></a>设置 - 更新个人信息</h3>
<div class="ulist">
<ul>
<li>
<p>地址 PUT <code>/api/settings</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>telegramName: Telegram用户名</p>
</li>
<li>
<p>website: 个人网站</p>
</li>
<li>
<p>bio: 个人简介</p>
</li>
<li>
<p>emailNotification: 是否接收邮箱通知</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="设置-发送激活邮件"><a class="anchor" href="#设置-发送激活邮件"></a>设置 - 发送激活邮件</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/settings/sendActiveEmail</code></p>
</li>
<li>
<p>请求类型 application/x-www-form-urlencoded</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="设置-发送邮箱验证码"><a class="anchor" href="#设置-发送邮箱验证码"></a>设置 - 发送邮箱验证码</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/settings/sendEmailCode</code></p>
</li>
<li>
<p>请求类型 application/x-www-form-urlencoded</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>email: 邮箱地址</p>
</li>
<li>
<p>code: 邮箱接收到网站发送的验证码</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="设置-更新用户邮箱"><a class="anchor" href="#设置-更新用户邮箱"></a>设置 - 更新用户邮箱</h3>
<div class="ulist">
<ul>
<li>
<p>地址 PUT <code>/api/settings/updateEmail</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>email: 邮箱地址</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="设置-修改密码"><a class="anchor" href="#设置-修改密码"></a>设置 - 修改密码</h3>
<div class="ulist">
<ul>
<li>
<p>地址 PUT <code>/api/settings/updatePassword</code></p>
</li>
<li>
<p>请求类型 application/json</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
<li>
<p>oldPassword: 旧密码</p>
</li>
<li>
<p>newPassword: 新密码</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result()</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="value">null</span>
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="设置-刷新token"><a class="anchor" href="#设置-刷新token"></a>设置 - 刷新token</h3>
<div class="ulist">
<ul>
<li>
<p>地址 GET <code>/api/settings/refreshToken</code></p>
</li>
<li>
<p>请求类型 application/x-www-form-urlencoded</p>
</li>
<li>
<p>参数</p>
<div class="ulist">
<ul>
<li>
<p>token</p>
</li>
</ul>
</div>
</li>
<li>
<p>返回 Result(String) // 返回新token</p>
</li>
</ul>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
  <span class="key"><span class="delimiter">&quot;</span><span class="content">code</span><span class="delimiter">&quot;</span></span>: <span class="integer">200</span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">SUCCESS</span><span class="delimiter">&quot;</span></span>,
  <span class="key"><span class="delimiter">&quot;</span><span class="content">detail</span><span class="delimiter">&quot;</span></span>: <span class="string"><span class="delimiter">&quot;</span><span class="content">208bb4c1-daf1-4a32-b198-7f4db8f6d565</span><span class="delimiter">&quot;</span></span>
}</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="q-a"><a class="anchor" href="#q-a"></a>Q&amp;A</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="数据库在哪"><a class="anchor" href="#数据库在哪"></a>数据库在哪？</h3>
<div class="paragraph">
<p>启动项目只需要配置好数据源连接地址，用户名，密码，其它都不用管，如果数据源连接信息都配置的对，启动还是报错，请查看你配置的MySQL用户是否有创建数据库以及表和对表的CRUD的权限</p>
</div>
</div>
<div class="sect2">
<h3 id="发帖技巧"><a class="anchor" href="#发帖技巧"></a>发帖技巧</h3>
<div class="ulist">
<ul>
<li>
<p>default主题的编辑器用的是 codemirror 实现的，可以对代码进行高亮，也可以通过 shift+tab/tab 进行缩进</p>
</li>
<li>
<p>上传图片，上传视频都有相应的链接，点一下就可以了</p>
</li>
<li>
<p>对视频网站的链接解析，目前支持了 <code>youtube</code> <code>bilibili</code> <code>qq</code> <code>youku</code> 四个网站的视频链接，直接把视频网页的链接拷贝过来贴在编辑器里即可，当渲染详情页的时候服务器会自动解析</p>
</li>
</ul>
</div>
</div>
<div class="sect2">
<h3 id="上传的图片为啥不显示"><a class="anchor" href="#上传的图片为啥不显示"></a>上传的图片为啥不显示</h3>
<div class="paragraph">
<p><strong>说明</strong></p>
</div>
<div class="ulist">
<ul>
<li>
<p>后台配置的静态资源`static`文件夹路径要跟程序启动的jar文件在一个目录内且同级请不要配置在其它地方，如果是用nginx映射的静态资源文件夹则没有这限制</p>
</li>
<li>
<p>windows下的路径要么是 <code>\\</code> 要么是 <code>/</code> 请不要用windows自带的一个 <code>\</code> 做路径，程序不认，会导致上传失败</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>首先这是个只会在用IDEA开发启动时出现的问题，原因是IDEA在启动SpringBoot项目的时候会把项目中的 <code>resources</code> 加载到内存里，pybbs中的`static`文件夹在resources里</p>
</div>
<div class="paragraph">
<p>所以项目启动之后，再上传到`static`文件夹里的文件就不会被idea自动加载了，这时候只需要在idea里build一下项目即可，不用重启</p>
</div>
</div>
<div class="sect2">
<h3 id="上传的视频格式有哪些"><a class="anchor" href="#上传的视频格式有哪些"></a>上传的视频格式有哪些</h3>
<div class="paragraph">
<p>因为html标签中的 video 标签默认支持 mp4 格式，所以我在default主题里的上传组件里限制了上传视频文件的类型为 <code>mp4</code> ，同时对图片的格式也做了限制 <code>png,jpg,gif</code></p>
</div>
</div>
<div class="sect2">
<h3 id="上传视频报413错误"><a class="anchor" href="#上传视频报413错误"></a>上传视频报413错误</h3>
<div class="paragraph">
<p>这是nginx报的错，需要对nginx配置一下 <code>client_max_body_size</code></p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code>location / {
    root   html;
    index  index.html index.htm;
    client_max_body_size    20m; # 限20MB大小
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>不过在程序的后台也有配置大小，那个配置会在controller里做校验，超出的话，会返回一个文件过大的信息</p>
</div>
</div>
<div class="sect2">
<h3 id="后台用户名密码是多少"><a class="anchor" href="#后台用户名密码是多少"></a>后台用户名密码是多少？</h3>
<div class="paragraph">
<p>快速开始文档里有</p>
</div>
</div>
<div class="sect2">
<h3 id="启动项目时报错"><a class="anchor" href="#启动项目时报错"></a>启动项目时报错</h3>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
错误信息: <code>java.lang.IllegalStateException: Failed to execute CommandLineRunner</code>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>这个错误一般是主题文件夹没有找到的错，可以参考一下这篇文章，如果是一样的错就对了 <a href="https://17dev.club/article/5c98adb7bbe14024b9e067b3">https://17dev.club/article/5c98adb7bbe14024b9e067b3</a></p>
</div>
<div class="paragraph">
<p>如果你是按照文档上的`快速开始`来启动的，就不会出现这个问题，开发环境加载的是`resources/templates`下的主题文件夹，正式环境加载的是 <code>./templates/theme</code></p>
</div>
<div class="paragraph">
<p>所以解决这个问题的方法就是区分开你是正式环境还是部署环境启动的</p>
</div>
<hr>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
错误信息: <code>No timezone mapping entry for 'GMT 8'</code>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>这是MySQL时区的问题，只在windows上有问题，我本机测试是把数据源里url链接后面的 <code>&amp;serverTimezone=GMT%2B8</code> 删了就可以了，不过也有用户反馈这种方法不行</p>
</div>
<div class="paragraph">
<p>那就换成另一种写法 <code>&amp;serverTimezone=Asia/Shanghai</code> 也是可以的</p>
</div>
</div>
<div class="sect2">
<h3 id="redis配置失败"><a class="anchor" href="#redis配置失败"></a>redis配置失败</h3>
<div class="paragraph">
<p>redis请不要开启auth，程序内集成的代码没有支持auth的配置</p>
</div>
<div class="paragraph">
<p>如果你非要支持auth选项，可以自行修改源码，源码类名是 <code>RedisService.java</code></p>
</div>
</div>
<div class="sect2">
<h3 id="发帖或者评论有emoji时提交失败"><a class="anchor" href="#发帖或者评论有emoji时提交失败"></a>发帖或者评论有emoji时提交失败</h3>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
错误信息: <code>### Error updating database. Cause: java.sql.SQLException: Incorrect string value: '\xF0\x9F\x98\x82' for column 'content' at row 1</code>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>mysql默认不支持emoji，要手动配置一下，让它支持就可以了，方法如下</p>
</div>
<div class="paragraph">
<p>修改mysql的配置文件，ubuntu的配置文件在 <code>/etc/mysql/mysql.conf.d/mysqld.cnf</code>，其它系统的配置文件自己找一下</p>
</div>
<div class="paragraph">
<p>打开找到 [mysqld] 在下面加上</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="conf">[mysqld]
character-set-client-handshake = FALSE
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci
init_connect='SET NAMES utf8mb4'</code></pre>
</div>
</div>
<div class="paragraph">
<p>加好后保存，然后重启mysql服务</p>
</div>
<div class="paragraph">
<p>接着把pybbs的表内字段有可能会出现emoji的字段的编码都改成 <code>utf8mb4_unicode_ci</code> 这个类型，再发帖就没问题了</p>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2020-04-21 14:24:46 +08:00
</div>
</div>
</body>
</html>